Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

Template Generator configuration file (Websydian.ini)

Overview

The Websydian.ini configuration file is used by the Windows based Websydian template generators and holds all required configuration properties. The Websydian.ini file is read when you run either the _DocumentTemplateGenerator of the _CreateTemplates from within the Plex IDE.

; Default folder location when running a function from within the Plex runtime is the GEN\Release folder

[WebSourceHTM]
sourcedir=.\templates\

[Websydian]
URL_Dispatcher=/(WSACTION)

[TemplateGenerator]
TemplateGenerator=c:\Websydian\Websydian v6.5\TemplateGenerator\TemplateGen.cmd
RunAutomatically=Y
NotifyWhenDone=Y
MetaTemplatePath=c:\Websydian\Websydian v6.5\TemplateGenerator\metatemplates\
GeneratedTemplatePath=.\templates\
xmltemplatefolder=..\xml\
MetaTemplateDebug=False
When the Windows based template generators are run from within the Plex IDE the current directory is the GEN\Release folder of your local model.

Filename and location

The file is named Websydian.ini and is required to be located in the GEN\Release of your local model.

WebSourceHTM section

The properties of this section is used by the _DocumentTemplateGenerator function.

sourcedir

This is a path definition where you would like to have your final templates generated.

Websydian section

The properties of this section is used by the _DocumentTemplateGenerator function.

URL_Dispatcher

This is the URL that will be added to each html form tag as href.

TemplateGenerator section

The properties of this section is used by the _CreateTemplates function.

MetaTemplatePath

This is the base path for the meta templates. The templates will be found in folders that is scoped by this folder - these subfolders will have the same name as the pagetype attribute.

Rules

The format must be a valid file path. The string must end with a "\"character. The specified folder must exist and have a subfolder with the name of the pagetype of the page the template is generated for.

Example

c:\Temp\Meta Templates\

GeneratedTemplatePath

The folder where the generated templates will be placed.

Rules

The property must be a valid file path. The string must end with a "\" character. The specified folder must exist.

Example

c:\Temp\Generated Files\

xmltemplatefolder

The folder where the XmlTemplateGenerator must place the generated xml template.

Rules

The folder must exist.

The value must end with a "\" character.

Example

c:\Temp\GeneratedXml\

RunAutomatically

Specifies whether the conversion of the generated XML template to HTML/JS/JSON templates should be performed when the XMLTemplateGenerator is run.

Rules

Possible values Y (The XML template will be converted) , N (The processing will stop after the XML template has been generated).

Example

Y

NotifyWhenDone

This determines whether a dialog message will be shown after the conversion of the XML template to HTML/JS/JSON templates.

Rules

Possible values Y (The dialog message will be shown) , N (The dialog message will not be shown).

Example

Y

TemplateGenerator

This specifies the location of the cmd file that will run the conversion of the XML template to HTML/JS/JSON templates.

Rules

The file must exist. The file must be a cmd file that starts the conversion process.

The delivered cmd file expects that it is placed in the folder structure it is delivered in - if this is not the case, the cmd will not be able to resolve the necessary jar files, property files etc.

The folder containing the cmd file must contain a folder named jars that contain all the jar files used by the conversion functions.

Example

C:\Temp\TemplateGenerator\TemplateGen.cmd

MetaTemplateDebug

This determines whether debug information will be written to the generated templates.

When this setting is Y, Information be written to the generated template each time a new meta template has been used. The line contains information about the function that has used the meta template, the location and full name of the meta template, and information about the detail element from the XML document handled by the function (if available).

A line is written to the generated template when the meta template is opened, and a corresponding line is written to the template when the meta template is closed.

Example (Field information for a field named Key in a js file):

/* BEGIN TEMPLATEGENERATION DEBUG: PageGenerator: Field; Template: c:/TemplateGenerator/metatemplates/wsyfields/FIELD_output_wsynumericfield.js; Element Name: Key */

AA9qF.wsyOutputFields.AA8uA = {xtype: Wsy.getLocale('AA9qF', 'fields.AA8uA.xtype', 'wsynumericfieldoutput'),wsyDataType: 'wsyInt',name: 'AA8uA',fieldLabel: Wsy.getLocale('AA9qF', 'fields.AA8uA.fieldLabel', 'Key')
,value: AA9qF.fieldvalues.AA8uA.value};

/* END TEMPLATEGENERATION DEBUG: PageGenerator: Field; Template: c:/TemplateGenerator/metatemplates/wsyfields/FIELD_output_wsynumericfield.js; Element Name: Key */

Rules

Possible values Y (The debug information will be inserted) , N (The debug information will not be inserted).

Example

Y